<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html
    PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<!-- /fasttmp/mkdist-qt-4.3.5-1211793125/qtopia-core-opensource-src-4.3.5/src/gui/text/qtextformat.cpp -->
<head>
  <title>Qt 4.3: QTextImageFormat Class Reference</title>
  <link href="classic.css" rel="stylesheet" type="text/css" />
</head>
<body>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left" valign="top" width="32"><a href="http://www.trolltech.com/products/qt"><img src="images/qt-logo.png" align="left" width="32" height="32" border="0" /></a></td>
<td width="1">&nbsp;&nbsp;</td><td class="postheader" valign="center"><a href="index.html"><font color="#004faf">Home</font></a>&nbsp;&middot; <a href="classes.html"><font color="#004faf">All&nbsp;Classes</font></a>&nbsp;&middot; <a href="mainclasses.html"><font color="#004faf">Main&nbsp;Classes</font></a>&nbsp;&middot; <a href="groups.html"><font color="#004faf">Grouped&nbsp;Classes</font></a>&nbsp;&middot; <a href="modules.html"><font color="#004faf">Modules</font></a>&nbsp;&middot; <a href="functions.html"><font color="#004faf">Functions</font></a></td>
<td align="right" valign="top" width="230"><a href="http://www.trolltech.com"><img src="images/trolltech-logo.png" align="right" width="203" height="32" border="0" /></a></td></tr></table><h1 align="center">QTextImageFormat Class Reference<br /><sup><sup>[<a href="qtgui.html">QtGui</a> module]</sup></sup></h1>
<p>The QTextImageFormat class provides formatting information for images in a <a href="qtextdocument.html">QTextDocument</a>. <a href="#details">More...</a></p>
<pre> #include &lt;QTextImageFormat&gt;</pre><p>Inherits <a href="qtextcharformat.html">QTextCharFormat</a>.</p>
<ul>
<li><a href="qtextimageformat-members.html">List of all members, including inherited members</a></li>
</ul>
<a name="public-functions"></a>
<h3>Public Functions</h3>
<ul>
<li><div class="fn"/><b><a href="qtextimageformat.html#QTextImageFormat">QTextImageFormat</a></b> ()</li>
<li><div class="fn"/>qreal <b><a href="qtextimageformat.html#height">height</a></b> () const</li>
<li><div class="fn"/>bool <b><a href="qtextimageformat.html#isValid">isValid</a></b> () const</li>
<li><div class="fn"/>QString <b><a href="qtextimageformat.html#name">name</a></b> () const</li>
<li><div class="fn"/>void <b><a href="qtextimageformat.html#setHeight">setHeight</a></b> ( qreal <i>height</i> )</li>
<li><div class="fn"/>void <b><a href="qtextimageformat.html#setName">setName</a></b> ( const QString &amp; <i>name</i> )</li>
<li><div class="fn"/>void <b><a href="qtextimageformat.html#setWidth">setWidth</a></b> ( qreal <i>width</i> )</li>
<li><div class="fn"/>qreal <b><a href="qtextimageformat.html#width">width</a></b> () const</li>
</ul>
<ul>
<li><div class="fn"/>35 public functions inherited from <a href="qtextcharformat.html#public-functions">QTextCharFormat</a></li>
<li><div class="fn"/>47 public functions inherited from <a href="qtextformat.html#public-functions">QTextFormat</a></li>
</ul>
<a name="details"></a>
<hr />
<h2>Detailed Description</h2>
<p>The QTextImageFormat class provides formatting information for images in a <a href="qtextdocument.html">QTextDocument</a>.</p>
<p>Inline images are represented by an object replacement character (0xFFFC in Unicode) which has an associated QTextImageFormat. The image format specifies a name with <a href="qtextimageformat.html#setName">setName</a>() that is used to locate the image. The size of the rectangle that the image will occupy is specified using <a href="qtextimageformat.html#setWidth">setWidth</a>() and <a href="qtextimageformat.html#setHeight">setHeight</a>().</p>
<hr />
<h2>Member Function Documentation</h2>
<h3 class="fn"><a name="QTextImageFormat"></a>QTextImageFormat::QTextImageFormat ()</h3>
<p>Creates a new image format object.</p>
<h3 class="fn"><a name="height"></a><a href="qtglobal.html#qreal-typedef">qreal</a> QTextImageFormat::height () const</h3>
<p>Returns the height of the rectangle occupied by the image.</p>
<p>See also <a href="qtextimageformat.html#width">width</a>() and <a href="qtextimageformat.html#setHeight">setHeight</a>().</p>
<h3 class="fn"><a name="isValid"></a>bool QTextImageFormat::isValid () const</h3>
<p>Returns true if this image format is valid; otherwise returns false.</p>
<h3 class="fn"><a name="name"></a><a href="qstring.html">QString</a> QTextImageFormat::name () const</h3>
<p>Returns the name of the image. The name refers to an entry in the application's resources file.</p>
<p>See also <a href="qtextimageformat.html#setName">setName</a>().</p>
<h3 class="fn"><a name="setHeight"></a>void QTextImageFormat::setHeight ( <a href="qtglobal.html#qreal-typedef">qreal</a> <i>height</i> )</h3>
<p>Sets the <i>height</i> of the rectangle occupied by the image.</p>
<p>See also <a href="qtextimageformat.html#height">height</a>() and <a href="qtextimageformat.html#setWidth">setWidth</a>().</p>
<h3 class="fn"><a name="setName"></a>void QTextImageFormat::setName ( const <a href="qstring.html">QString</a> &amp; <i>name</i> )</h3>
<p>Sets the <i>name</i> of the image. The <i>name</i> is used to locate the image in the application's resources.</p>
<p>See also <a href="qtextimageformat.html#name">name</a>().</p>
<h3 class="fn"><a name="setWidth"></a>void QTextImageFormat::setWidth ( <a href="qtglobal.html#qreal-typedef">qreal</a> <i>width</i> )</h3>
<p>Sets the <i>width</i> of the rectangle occupied by the image.</p>
<p>See also <a href="qtextimageformat.html#width">width</a>() and <a href="qtextimageformat.html#setHeight">setHeight</a>().</p>
<h3 class="fn"><a name="width"></a><a href="qtglobal.html#qreal-typedef">qreal</a> QTextImageFormat::width () const</h3>
<p>Returns the width of the rectangle occupied by the image.</p>
<p>See also <a href="qtextimageformat.html#height">height</a>() and <a href="qtextimageformat.html#setWidth">setWidth</a>().</p>
<p /><address><hr /><div align="center">
<table width="100%" cellspacing="0" border="0"><tr class="address">
<td width="30%">Copyright &copy; 2008 <a href="trolltech.html">Trolltech</a></td>
<td width="40%" align="center"><a href="trademarks.html">Trademarks</a></td>
<td width="30%" align="right"><div align="right">Qt 4.3.5</div></td>
</tr></table></div></address></body>
</html>
